Vcenter Guest AdapterMapping

Vcenter Guest AdapterMapping
Vcenter Guest AdapterMapping

The Vcenter Guest AdapterMapping schema specifies the association between a virtual network adapter and its IP settings.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "mac_address": "string",
    "adapter": {
        "ipv4": {
            "type": "string",
            "ip_address": "string",
            "prefix": 0,
            "gateways": [
                "string"
            ]
        },
        "ipv6": {
            "type": "string",
            "ipv6": [
                {
                    "ip_address": "string",
                    "prefix": 0
                }
            ],
            "gateways": [
                "string"
            ]
        },
        "windows": {
            "dns_servers": [
                "string"
            ],
            "dns_domain": "string",
            "wins_servers": [
                "string"
            ],
            "net_bios_mode": "string"
        }
    }
}
string
mac_address
Optional

The MAC address of a network adapter being customized.

In vSphere 7.0 series, the MAC addresses must be specified in the ascending order of pciSlotNumber, otherwise a MAC address mismatch error will be reported. For further details, see the https://kb.vmware.com/s/article/87648

This property was added in vSphere API 7.0.0.0.

If missing or null, the customization process maps the the settings from the list of AdapterMappings.IPSettings in the Vcenter Guest CustomizationSpec.interfaces to the virtual machine's network adapters, in PCI slot order. The first virtual network adapter on the PCI bus is assigned interfaces[0].IPSettings, the second adapter is assigned interfaces[1].IPSettings, and so on.

adapter
Required

The IP settings for the associated virtual network adapter.

This property was added in vSphere API 7.0.0.0.